docs: add getting-started guide for VS Code + CMake build setup#39
Draft
Yusuf-Serdar wants to merge 3 commits into
Draft
docs: add getting-started guide for VS Code + CMake build setup#39Yusuf-Serdar wants to merge 3 commits into
Yusuf-Serdar wants to merge 3 commits into
Conversation
Yusuf-Serdar
force-pushed
the
docs/getting-started
branch
from
d1b5855 to
d056178
Compare
Yusuf-Serdar
force-pushed
the
docs/getting-started
branch
from
d056178 to
090c736
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #38
Adds
docs/getting-started.mdwith step-by-step instructions for setting up the build environment on Windows (VS Code, CMake, Ninja, Arm GNU Toolchain) and building the firmware for all three module presets.Also includes an optional section on STM32CubeMX for viewing/modifying the
.iocperipheral configuration.Not yet covered (will be added once hardware is available and tested):